docs: clarify VS Code ignore rules in Python.gitignore#4785
docs: clarify VS Code ignore rules in Python.gitignore#4785ViratiAkiraNandhanReddy wants to merge 4 commits intogithub:mainfrom
Python.gitignore#4785Conversation
This change clarifies how Visual Studio Code workspace files can be optionally ignored in python.gitignore while allowing contributors to track shared settings.json if desired.
|
Please Review This PR ; @thorrsson |
|
I don't think that making this more verbose is useful, nor do I think committing only the We include the comment here since it is a common request to ignore the whole folder, but it really goes against our contribution guidelines to do so. We'd end up including snippets like this in every language template if we weren't strict about it. Going to close this out 👍 I'd recommend adding the contents of the VSCode template to your global ignore file instead if you are running into issues with this. |
|
Thanks for taking the time to explain this and for the clarification I appreciate the suggestion about using the global ignore setup. I’ll try to come back later with a better-quality, more meaningful PR that fits the project standards better. Thanks again for the feedback. |
3 participants
This change clarifies how Visual Studio Code workspace files can be optionally ignored in python.gitignore while allowing contributors to track shared settings.json if desired.
Reasons for making this change
The current comments reference ignoring the entire .vscode directory but do not clearly document the common pattern of allowing settings.json while ignoring other files. This change improves clarity without altering default behavior.
Merge and Approval Steps
@thorrsson @dooleydevin